home *** CD-ROM | disk | FTP | other *** search
/ Apple Reference & Present…nuary (Partner) - Disc 1 / The Apple Reference and Presentations Library (Disc 1)(January 1994).iso / Frame Technology / US English / FrameMaker 4-PPC / Help / syntax3.hlp (.txt) < prev    next >
Encoding:
FrameMaker Help  |  1994-04-13  |  58.6 KB  |  397 lines  |  [FHlp/Fram]

  1. syntax3.hlp
  2. FHlpFram
  3. <MakerFile 4.0K>
  4. Footnote
  5. TableFootnotet
  6. Index
  7. Fonts
  8. Imported Graphics
  9. CellHead
  10. gotolink syntax4.hlp:firstpage    b
  11. nextpage
  12. nextpageBo    d
  13. popup Menu    e
  14. previouslink
  15. previouspage
  16. nextpage
  17. popup Menu    o
  18. previouslink
  19. previouspage
  20. nextpage
  21. nextpage
  22. gotolink .hlp:lastpage    u
  23. gotolink .hlp:firstpageE
  24. 0gotolink syntax1.hlp:Menu of Syntax Descriptions    q    w
  25. >gotolink syntax1.hlp:As Is setting in windows and dialog boxes    x
  26. 2gotolink syntax1.hlp:Autonumbering Building Blocks    y
  27. ;gotolink syntax1.hlp:Cross-reference Format Building Blocks[    
  28. 8gotolink syntax2.hlp:Variable Definition Building Blocks
  29. 6gotolink syntax3.hlp:Special Characters (Find/Replace)    |
  30. (gotolink syntax3.hlp:Wildcard Characters
  31. -gotolink syntax3.hlp:List Specification Flows
  32. .gotolink syntax3.hlp:Index Specification Flows    
  33. .gotolink syntax4.hlp:Hypertext Marker Commands    
  34. "gotolink syntax4.hlp:Index Markers    
  35. )newlink Special Characters (Find/Replace):    
  36. ,special characters in Find/Change dialog box
  37. newlink Wildcard Charactersspa    
  38. wildcard characters
  39.  newlink List Specification Flowsio    
  40. 0tables of contents:specification flow syntax for
  41. !newlink Index Specification Flowse    
  42. %indexes:specification flow syntax foro    
  43. gotolink syntax2.hlp:lastpagei    
  44. nextpagego    
  45. nextpage:A    
  46. nextpagend    
  47. nextpagees    
  48. nextpage s    
  49. nextpagebe    
  50. gotolink syntax4.hlp:firstpage    
  51. nextpage
  52. <$lastpagenum>
  53. <$monthname> <$daynum>, <$year>a
  54. "<$monthnum>/<$daynum>/<$shortyear>ta
  55. ;<$monthname> <$daynum>, <$year> <$hour>:<$minute00> <$ampm>c
  56. "<$monthnum>/<$daynum>/<$shortyear>.h
  57. <$monthname> <$daynum>, <$year>o
  58. "<$monthnum>/<$daynum>/<$shortyear>ds
  59. <$fullfilename>a
  60. <$filename>s
  61. <$paratext[HiddenTitle]>
  62. <$paratext[Title]>ne
  63. <$curpagenum>in 
  64. <$marker1> b
  65. <$marker2>in
  66.  (continued)
  67. + (Sheet <$tblsheetnum> of <$tblsheetcount>)n
  68. Heading & Page
  69. <$paratext>
  70.  on page
  71. <$pagenum>ts
  72. <$pagenum>f
  73. See Heading & Page
  74. %See 
  75. <$paratext>
  76.  on page
  77. <$pagenum>.e
  78. Table & Page
  79. 7Table
  80. <$paranumonly>, 
  81. <$paratext>,
  82.  on page
  83. <$pagenum>s
  84. <$paratag[Body]>
  85. ProductName
  86. <Default 
  87.  Font>FrameMaker
  88. This sequence
  89. Searches for
  90. Tab characters
  91. Forced return
  92. End of paragraph
  93. Beginning of paragraph
  94. Backslash
  95. Discretionary hyphen
  96. Suppress hyphenation symbol
  97. End-of-flow symbol
  98. 8You can use these characters only in the Find text box.
  99. Start of word
  100. End of word
  101. This character
  102. Finds
  103.  (asterisk)
  104. :Zero or more characters, excluding spaces and punctuation
  105. | (vertical bar)
  106. 9One or more spaces and punctuation characters that end a >
  107. 7Any single character, excluding spaces and punctuation
  108. Start of line
  109. End of line
  110. *Any one of the characters in the brackets
  111. [^ab]
  112. "Any character not in the brackets
  113. [a-b]
  114. Any one character in a range
  115. \other
  116. 5Specified character (for example, \* searches for an 
  117. asterisk)
  118. Building block
  119. Effect
  120. <$pagenum>
  121. 0Inserts the page number of the listed paragraph
  122. <$nopage>
  123. 1Excludes the page number of the listed paragraph
  124. <$paratext>
  125. )Inserts the text of the listed paragraph
  126. <$paranum>
  127. 9Inserts the autonumbering string of the listed paragraph
  128. <$paranumonly>
  129. :Inserts the autonumbering string of the listed paragraph, 
  130. 'excluding any leading or trailing text
  131. <Paragraph formats in the index specification flow 
  132. Paragraph tagged
  133. Specifies
  134. SeparatorsIX
  135. !How to separate the page numbers
  136. Example:
  137. 5Multiple page numbers for one entry are separated by  
  138. 2a comma and space. Page ranges are separated by a 
  139. hyphen.
  140. SortOrderIX
  141. %The sort order for the index entries
  142. Example:
  143. $<$symbols><$numerics><$alphabetics>
  144. 9The index will list symbols first, then numeric entries, 
  145. and then alphabetic entries.
  146.     Level1IX
  147.     Level2IX
  148. 4Formatting of the different levels of index entries
  149. Example:
  150.     Level1IX
  151. LeveI2
  152. 8The index has two levels. First-level entries are flush 
  153. -left, and second-level entries are indented.
  154. GroupTitlesIX
  155. +The title for each sorted group of entries
  156. Example:
  157. Symbols[\ ];Numerics[0];    i
  158. 4A;B;C;D;E;F;G;H;I;J;K;L;M;N;O;P;Q;R;S;T;U;V;W;X;Y;Z
  159. 7Group titles will be bold in the index. Note that each 
  160. $title is separated by a semicolon. 
  161. IgnoreCharsIX
  162. 0The characters to ignore when sorting the index ra
  163. entries
  164. Example:
  165. -Hyphens, en dashes and em dashes are ignored 
  166. when the entries are sorted.
  167. IndexIX
  168. 4The contents and format of the page number to which UU
  169. each entry refers
  170. Example:
  171. <$pagenum>
  172. 3The page number for each entry will be bold in the by 
  173. index. 
  174. 0Building blocks in the index specification flow
  175. Building block
  176. Effect
  177. <$symbols>    
  178. <$numeric>    
  179. <$alphabetics>
  180. 4Used in the paragraph tagged SortOrderIX to specify 
  181. 4how the index entries are sorted. The order ascends 
  182. from left to right.
  183. <$pagenum>
  184. 4Inserts the number of the page containing the index 
  185. 5marker. When this building block is in the paragraph u
  186. 4tagged IndexIX, page numbers appear for each entry.
  187. <$nopage>
  188. 3Excludes the page number of the index marker. When 
  189. 8this building block is in the paragraph tagged IndexIX, 
  190. the index has no page numbers.
  191. Paragraph tagged
  192. Specifies
  193. Heading1TOC
  194. Section <$paranumonly>
  195. Heading2TOC
  196. <$paratext>
  197. <$pagenum>
  198. Heading3TOC
  199. <$paratext>
  200. <$pagenum>
  201. SYNTAX DESCRIPTIONS
  202. Go To
  203. Running H/F 2
  204. (continued) 
  205. SYNTAX DESCRIPTIONS
  206. Go To
  207.     TitleRule
  208. TableFootnote
  209. Go To
  210. Menu of Syntax Descriptions
  211. As Is setting in windows and dialog boxes
  212. Autonumber building blocks
  213. Cross-reference format building blocks
  214. Variable definition building blocks
  215. Special characters (Find/Change)
  216. Wildcard characters
  217. List specification flows
  218. Index specification flows
  219. Hypertext commands
  220. Index markers
  221. Special 
  222. characters (Find/Change)
  223. Wildcard 
  224. characters
  225. List 
  226. specification flows
  227. GGenerated lists are formatted according to a special flow that is on a d/C
  228. Mreference page. For each list you generate, 
  229. FrameMaker
  230.  creates a new 
  231. reference page.
  232. LThe special flow contains paragraphs whose formats are the same as those in do
  233. Lthe generated list. These paragraphs contain building blocks that determine 
  234. &the contents of each list entry. 
  235. Moreer
  236. Example
  237. LBased on the preceding reference page specification, the generated table of fo
  238. &contents would include the following:
  239. Section 1
  240. First heading
  241. following
  242. topic
  243. Another
  244. following
  245. topic
  246. Just another heading
  247. Section 2
  248. Hypertext links in lists
  249. TWhen you generate hypertext links in a list, 
  250. FrameMaker
  251.  inserts a paragraph 
  252. Nin the specification flow to define the type of links generated. For example, 
  253. Lwhen you generate an active table of contents, 
  254. FrameMaker
  255.  inserts a 
  256. paragraph tagged ActiveTOC.
  257. NYou should type the link definitions exactly as shown. Use the <$relfilename> 
  258. Nbuilding block to generate a relative pathname from the generated list to the 
  259. Fother document. The following examples all use <$fullfilename>, which 
  260. )generates the complete path of the file.
  261. &You can generate five types of links:
  262. 7gotoObjectId
  263. <$fullfilename>:<$Objecttype>
  264. <$ObjectId>    
  265. ;displays the selected item centered in the current window.
  266. 7openObjectId
  267. <$fullfilename>:<$Objecttype>
  268. <$ObjectId>    lis
  269. 5displays the selected item centered in a new window.
  270. More d
  271. (gotopage
  272. <$fullfilename>:<$pagenumonly>    
  273. ?displays the page in the current window with nothing selected.
  274. )openpage
  275. <$fullfilename>:<$pagenumonly>     
  276. 9displays the page in a new window with nothing selected.
  277. alert
  278. <$fullfilename>    
  279. Bdisplays an alert that shows the filename of the source document.
  280. Index 
  281. specification flows
  282. HA generated index is formatted according to a special flow that is on a 
  283. reference page.
  284. FThe special flow contains paragraphs. The formats of these paragraphs 
  285. Mdetermine what aspect of the index the paragraphs specify and the formats of y
  286. the resulting entries.
  287. More:<
  288. Moreic
  289. More y
  290. GThe paragraphs on the reference page contain building blocks, as shown 
  291. here:
  292. Hypertext links in indexes
  293. LWhen you generate hypertext links in an index, 
  294. FrameMaker
  295.  inserts a 
  296. Oparagraph in the specification flow to define the type of links generated. For 
  297. Iexample, when you generate an active index, 
  298. FrameMaker
  299.  inserts a 
  300. paragraph tagged ActiveIX.
  301. NYou should type the link definitions exactly as shown. Use the <$relfilename> 
  302. Obuilding block to generate the name of a relative path from the generated file 
  303. Mto the other document. The following examples all use <$fullfilename>, which 
  304. )generates the complete path of the file.
  305. &You can generate five types of links:
  306. 7gotoObjectId
  307. <$fullfilename>:<$Objecttype>
  308. <$ObjectId>    
  309. ;displays the selected item centered in the current window.
  310. 7openObjectId
  311. <$fullfilename>:<$Objecttype>
  312. <$ObjectId>    
  313. 5displays the selected item centered in a new window.
  314. Moreer
  315. (gotopage
  316. <$fullfilename>:<$pagenumonly>    mp
  317. ?displays the page in the current window with nothing selected.
  318. )openpage
  319. <$fullfilename>:<$pagenumonly>     O
  320. 9displays the page in a new window with nothing selected.
  321. alert
  322. <$fullfilename>    
  323. Bdisplays an alert that shows the filename of the source document.
  324. Right
  325.     Continued
  326.     Reference
  327. popups
  328.     Continued
  329.     Continued
  330.     Continued
  331.     Continued
  332.     Continuedopa
  333.     Continued
  334.     Continuedn t
  335.     Continueded.
  336.     Continuedf
  337. CellBody
  338. CellHeadingt
  339. TableTitle
  340.     TableRule
  341. CellHead
  342. CellBody
  343. TableFootnotee
  344. BodyCUD2
  345. CellBodyCUD
  346. BodyCUD
  347. BodyCUD2
  348. CellBodyCud
  349. CellBodyCud
  350. CellBodyCud
  351. Header
  352. Footer
  353. Title
  354.     TitleRule
  355. DocTitle
  356. PopUpT
  357. CellBodyCud
  358. CellBodyCud
  359. CellBodyCud
  360. Bullet
  361. PBBullet
  362. PBBody
  363. Button
  364. SmallRunningHeader
  365. Medium
  366. Double
  367. Thick
  368.     Very Thin
  369. BuildingBlock
  370. BuildingBlock
  371. BuildingBlockNoTitle
  372. Builder    
  373. Comment
  374. Maker(
  375. Windows
  376. Black
  377. White
  378. Green
  379. Magenta
  380. Yellow
  381.     Helvetica
  382. Helvetica-Bold
  383. Times-Roman
  384. Times
  385.     Helvetica
  386. Regular
  387. Regular
  388. Regular
  389. *r#.Y^
  390. syntax3.hlp
  391. FHlpFram
  392. FHlpFram
  393. 4.0.3#4.0.3, 
  394.  Frame Technology 1988-1994
  395. 4.0.3
  396. FrameMaker Version 4.0.3
  397.